List Transactions

Summary

The List Transactions endpoint can be used to retrieve a list of open transactions and property addresses associated with a user account.

HTTP Request

The List Transactions endpoint requires a GET request and a url with the following pattern:

Production:

GET https://partner-api.endpointclosing.com/v1/transactions

Sandbox:

GET https://partner-api-sandbox.endpointclosing.com/v1/transactions

Request Header

The request header must contain a JWT obtained from the authentication endpoint in the format: Authorization: Bearer ${JSON Web Token}. See Authentication for more details.

Query Parameters

Parameter	Description	Type	Required
pageIndex	Zero-index-based page number	Integer	Optional
itemsPerPage	The number of transactions to be returned per page	Integer	Optional
closedStatus	Limits results to open or closed transactions	Boolean	Optional
servicedBy	Limits results to a specific organization	String	Optional

Response

Success

A successful request will result in a response with an HTTP code of 200 and a body containing a list of all open transactions associated with the partner identified by API key.

Main Attributes

Parameter	Description	Type
transactions	A list of transactions	Transaction objects
pageIndex	Zero-index-based current page number	Integer
itemsPerPage	The number of documents returned per page	Integer
totalPages	Number of total pages in the response	Integer

Transaction Object

Parameter	Description	Type
transactionId	ID of the transaction. Returned from the create-transaction	String
externalOrderId	Optional partner-provided ID of the transaction	String or Null
property	Object which contains an address or parcel number	Property object
servicedBy	Name of organization processing the transaction	String

Property Object

Parameter	Description	Type
address	Address for the property on the transaction	Address object
parcelNumber	Identification number used to identify properties	String or Null

Address Object

Parameter	Description	Type
street1	House/Building number and street name of the property	String
street2	Apt/Unit number of the property	String or Null
city	City of the property	String
state	Postal abbreviation of state of the property	String
zip	Zip of the property	String
county	County of the property	String

Sample Success Response

{
  "pageIndex": 0,
  "itemsPerPage": 10,
  "totalPages": 1,
  "transactions": [
    {
      "transactionId": "abc123",
      "externalOrderId": "partner-123",
      "property": {
        "address": {
          "street1": "123 Main St",
          "street2": "Apt. 100",
          "city": "Los Angeles",
          "state": "CA",
          "zip": "90024",
          "county": "Los Angeles"
        },
        "parcelNumber": "11-22-3333"
      },
      "servicedBy": "Endpoint"
    },
    {
      "transactionId": "edf456",
      "externalOrderId": "partner-456",
      "property": {
        "address": {
          "street1": "123 Main St",
          "street2": "Apt. 101",
          "city": "Los Angeles",
          "state": "CA",
          "zip": "90024",
          "county": "Los Angeles"
        },
        "parcelNumber": "11-22-2345"
      },
      "servicedBy": "Endpoint"
    }
  ]
}

Error

A request resulting in an error will return a response with the appropriate HTTP code and body containing error details.

{
  "error": "{error type}"
  "message": ["{error message}"]
  "statusCode": status_code,
}

Error Codes

Error	Description	HTTP Code
Bad Request	Request invalid or missing required data. Error details, such as missing fields, will be specified in the message field of the response	400
Unauthorized	Missing or invalid JWT. See Authentication for more details.	401
Forbidden	The given API key is not authorized for this resource	403
Too Many Requests	Partner application has reached its API rate limit	429